References and automatic numbering for figures and tables
Gavin Radolan <[email protected]> Mon, 27 Apr 2015 19:26:28 -0400
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <CAL0F6Xj2NS11dmZWtR7mdnKTjnuQOmrbyn4=OQL=Ue6mun00WQ@mail.gmail.com> |
--===============4404984821422239463==
Content-Type: multipart/alternative; boundary=f46d0442883e4f62280514bd1322
--f46d0442883e4f62280514bd1322
Content-Type: text/plain; charset=UTF-8
Hello,
I'm using Doxygen to create a reference manual. Input is markdown. Output
is LaTeX and html. Currently using Doxygen 1.8.8.
I'm wondering if there are any plans for Doxygen to support automatic
numbering of figures and tables, with referencing capability from the
markdown text?
For example, behavior similar to the @section command's LaTeX output. But
separate enumeration for figures and another separate enumeration for
tables. And with the enumeration showing up in both LaTeX and html output.
Syntax might be something like this,
At the figure:
or maybe
@figure fig_name "Growth rate vs time"
The first example is preferable for it's simplicity, but maybe it's
difficult to have ![Caption text ] used for multiple purposes...
At the table:
@table tab_name Growth rate data 2009 - 2014
| Year | Growth Rate|
|:------:|-----------------:|
| 2009| 0.3245 |
....whatever....
In the body text:
The growth rate for the last five years is shown in \ref tab_name. As can
be seen in /ref fig_name, the growth rate is logarithmic.
In the generated pdf/html:
The growth rate for the last five years is shown in Table 93: Growth rate
2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the growth
rate is logarithmic.
So "Figure N" and "Table M" are automatically generated and pre-pended to
the caption for each figure/table in the document. And you can link to any
figure or table anyplace in the doc using a /ref tag.
I've noticed some users implement similar functionality with
post-processing scripts or other "add-on" tools, such as doxynum. I could
do likewise, but first, wanted to ask whether or not there are plans to
have such functionality "built-in" to Doxygen - and if so, approximately
when?
Kind regards,
Gavin Radolan
--f46d0442883e4f62280514bd1322
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
<div dir=3D"ltr"><div>Hello,</div><div><br></div><div>I'm using Doxygen=
to create a reference manual. Input is markdown. Output is LaTeX and html.=
Currently using Doxygen 1.8.8.</div><div><br></div><div>I'm wondering =
if there are any plans for Doxygen to support automatic numbering of figure=
s and tables, with referencing capability from the markdown text?</div><div=
><br></div><div>For example, behavior similar to the @section command's=
LaTeX output. But separate enumeration for figures and another separate en=
umeration for tables. And with the enumeration showing up in both LaTeX and=
html output.</div><div><br></div><div>Syntax might be something like this,=
</div><div><br></div><div>At the figure:</div><div><br></div><div>=C2=A0 =
=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0</div><div><br></div><div>or maybe<=
/div><div><div><br></div><div>=C2=A0=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0</div><=
/div><div>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 @figure fig_name "Growth =
rate vs time"<br></div><div><br></div><div>The first example is prefer=
able for it's simplicity, but maybe it's difficult to have ![Captio=
n text ] used for multiple purposes...</div><div><br></div><div>At the tabl=
e:</div><div><br></div><blockquote style=3D"margin:0px 0px 0px 40px;border:=
none;padding:0px"><div>@table tab_name Growth rate data 2009 - 2014</div></=
blockquote><blockquote style=3D"margin:0px 0px 0px 40px;border:none;padding=
:0px"><div><br></div><div>| Year | Growth Rate|</div><div>|:------:|-------=
----------:|</div></blockquote><blockquote style=3D"margin:0px 0px 0px 40px=
;border:none;padding:0px"><div>| 2009| =C2=A0 =C2=A0 =C2=A0 =C2=A0 0.3245 =
=C2=A0|</div></blockquote><blockquote style=3D"margin:0px 0px 0px 40px;bord=
er:none;padding:0px"><div>....whatever....</div><div>=C2=A0=C2=A0 =C2=A0</d=
iv></blockquote><div>In the body text:</div><blockquote style=3D"margin:0px=
0px 0px 40px;border:none;padding:0px"><div><br></div><div>The growth rate =
for the last five years is shown in \ref tab_name. As can be seen in /ref f=
ig_name, the growth rate is logarithmic.</div></blockquote><div><br></div><=
div>In the generated pdf/html:</div><div><br></div><blockquote style=3D"mar=
gin:0px 0px 0px 40px;border:none;padding:0px">The growth rate for the last =
five years is shown in Table 93: Growth rate 2009 - 2014. As can be seen in=
Figure 125: Growth rate vs time, the growth rate is logarithmic.<br><br></=
blockquote>So "Figure N" and "Table M" are automaticall=
y generated and pre-pended to the caption for each figure/table in the docu=
ment. And you can link to any figure or table anyplace in the doc using a /=
ref tag.=C2=A0<div><br><div>I've noticed some users implement similar f=
unctionality with post-processing scripts or other "add-on" tools=
, such as doxynum. I could do likewise, but first, wanted to ask whether or=
not there are plans to have such functionality "built-in" to Dox=
ygen - and if so, approximately when?</div><div><br></div><div><div dir=3D"=
ltr">Kind regards,<div><br></div><div>Gavin Radolan</div><div><br></div><di=
v><br></div></div></div>
</div></div>
--f46d0442883e4f62280514bd1322--
--===============4404984821422239463==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
------------------------------------------------------------------------------
One dashboard for servers and applications across Physical-Virtual-Cloud
Widest out-of-the-box monitoring support with 50+ applications
Performance metrics, stats and reports that give you Actionable Insights
Deep dive visibility with transaction tracing using APM Insight.
http://ad.doubleclick.net/ddm/clk/290420510;117567292;y
--===============4404984821422239463==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
_______________________________________________
Doxygen-develop mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-develop
--===============4404984821422239463==--